Update documentation by yhaliaw · Pull Request #150 · canonical/github-runner-operator

yhaliaw · 2023-11-21T07:15:54Z

Applicable spec:

Overview

Update the documentation to match with the discourse.charmhub.io.

Rationale

Keeping the documentation in sync is good 🚀.

Checklist

The charm style guide was applied
The contributing guide was applied
The changes are compliant with ISD054 - Managing Charm Complexity
The documentation is generated using src-docs
The documentation for charmhub is updated.
The PR is tagged with appropriate label (urgent, trivial, complex)

yanksyoon

Minor comment, LGTM!

cbartz

Looks good overall, found some minor spelling mistakes.

Co-authored-by: Christopher Bartz <christopher.bartz@canonical.com>

amandahla

LGTM

cbartz

LGTM. The only thing missing is the COS integration guide, but we can provide that later.

github-actions · 2023-12-01T13:44:36Z

Test coverage for 8cafac8

Name                    Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------
src/charm.py              429     98    107     25    75%   79-80, 86-88, 112-113, 117-119, 155-157, 167->179, 177, 220-228, 240-244, 275, 352-357, 378, 395-396, 405-428, 446-448, 456-459, 466, 469-470, 486, 491-496, 541->544, 557-558, 560-561, 595-602, 626-627, 639-641, 656-657, 682-683, 685-686, 688-689, 763->765, 826-827, 843, 861-863, 867
src/charm_state.py         50      6      6      0    86%   76-83
src/errors.py              34      0      0      0   100%
src/event_timer.py         42      8      4      0    74%   94-97, 117-120
src/firewall.py            43     25     10      0    38%   38-42, 64-67, 75-149
src/github_type.py         36      0      0      0   100%
src/lxd_type.py            37      0      2      0   100%
src/metrics.py             67      2     10      1    96%   60->63, 150-151
src/runner.py             334     70    108     26    74%   49->51, 105, 210-217, 223-229, 256-257, 301-310, 334-339, 344, 364, 368-378, 427->430, 433-435, 442, 456, 466, 470, 472, 487, 535-540, 556-569, 580-612, 617, 655, 701-703, 707, 725, 760, 786, 791-803, 817, 837, 853
src/runner_manager.py     273     26    102      9    90%   166, 223-225, 238-239, 251-253, 259-264, 268-269, 279-280, 299, 422, 441-445, 470, 553, 702, 722
src/runner_metrics.py     112      5     22      2    95%   133-134, 146, 215-216
src/runner_type.py         55      0     12      0   100%
src/shared_fs.py           80     10     12      0    89%   73-74, 160-161, 166-167, 173-174, 196-197
src/utilities.py           68      6     20      8    84%   74->76, 78->84, 89-91, 121, 135, 173, 226
-------------------------------------------------------------------
TOTAL                    1660    256    415     71    82%

Static code analysis report

Run started:2023-12-01 13:35:58.462605

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 3720
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 10

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

Update documentation

db6b967

yhaliaw added documentation Improvements or additions to documentation trivial labels Nov 21, 2023

github-actions Bot added the Libraries: OK label Nov 21, 2023

Fix typo

b522a64

yhaliaw marked this pull request as ready for review November 21, 2023 08:18

yhaliaw requested a review from a team as a code owner November 21, 2023 08:18